﻿#region Copyright
// Copyright (c) 2011-2012 RaisingForce Team (Alikin Sergey)
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
#endregion

using System.Diagnostics.Contracts;
using RaisingForce.Raise.Measures;

namespace RaisingForce.Raise.Hardware
{
    /// <summary>
    /// Представляет интерфейс доступа к двигателю робота.
    /// </summary>
    /// <remarks>
    /// Все методы и свойства интерфейса могут быть вызваны асинхронно
    /// из разных потоков для объекта, реализующего интерфейс.
    /// Требуется обеспечить их потокобезопасность.
    /// <para>Для упрощения реализации интерфейса следует унаследовать
    /// класс реализации от абстрактного класса <see cref="RobotEngine"/>.</para>
    /// </remarks>
    /// <seealso cref="IRobotHardware"/>
    [ContractClass(typeof(IRobotEngineContract))]
    public interface IRobotEngine
    {
        /// <summary>
        /// Выполняет поворот робота вокруг своей оси на заданный угол в указанном направлении.
        /// </summary>
        /// <param name="rotationAngle">Угол, на который робот должен повернуться.</param>
        /// <param name="rotationDirection">Направление поворота - либо по часовой, либо против часовой стрелки.</param>
        /// <exception cref="RobotHardwareException">
        /// Произошла ошибка с оборудованием или робот не ответил вовремя.
        /// </exception>
        /// <remarks>
        /// <para>Данный метод должен задействовать двигатель,
        /// дождаться завершения маневра и остановить двигатель.
        /// Метод вызывается всегда после того, как соединение с роботом
        /// было установлено методом <c>IRobotHardware.Connect()</c>.</para>
        /// <para>В процессе ожидания ответа от робота метод должен тратить минимум
        /// процессорного времени, передавая управление другим потокам
        /// с помощью метода <c>System.Threading.Thread.Sleep()</c>.</para>
        /// <para>В случае невозможности успешного выполнения задачи
        /// (например из-за ошибки с оборудованием робота)
        /// метод должен выбрасывать исключение <c>RobotHardwareException</c>.
        /// Другие типы исключений недопустимы.</para>
        /// </remarks>
        /// <seealso cref="IRobotEngine"/>
        /// <seealso cref="IRobotHardware"/>
        /// <seealso cref="RobotHardwareException"/>
        /// <seealso cref="System.Threading.Thread"/>
        void Rotate(Angle rotationAngle, RotationDirection rotationDirection);

        /// <summary>
        /// Выполняет движение робота на заданное расстояние в указанном направлении (вперед или назад).
        /// </summary>
        /// <param name="movementDistance">
        /// Расстояние, на которое робот должен переместиться по направлению
        /// своего движения. Значение <c>Distance.Unknown</c> недопустимо.</param>
        /// <param name="movementDirection">
        /// Направление движения робота - вперед или назад.</param>
        /// <exception cref="RobotHardwareException">
        /// Произошла ошибка с оборудованием или робот не ответил вовремя.
        /// </exception>
        /// <remarks>
        /// <para>Данный метод должен задействовать двигатель,
        /// дождаться завершения маневра и остановить двигатель.
        /// Метод вызывается всегда после того, как соединение с роботом
        /// было установлено методом <c>IRobotHardware.Connect()</c>.</para>
        /// <para>В процессе ожидания ответа от робота метод должен тратить минимум
        /// процессорного времени, передавая управление другим потокам
        /// с помощью метода <c>System.Threading.Thread.Sleep()</c>.</para>
        /// <para>В случае невозможности успешного выполнения задачи
        /// (например из-за ошибки с оборудованием робота)
        /// метод должен выбрасывать исключение <c>RobotHardwareException</c>.
        /// Другие типы исключений недопустимы.</para>
        /// </remarks>
        /// <seealso cref="IRobotEngine"/>
        /// <seealso cref="IRobotHardware"/>
        /// <seealso cref="RobotHardwareException"/>
        /// <seealso cref="System.Threading.Thread"/>
        void Move(Distance movementDistance, MovementDirection movementDirection);

        /// <summary>
        /// Подаёт команду двигателю робота на немедленную остановку
        /// и дожидается окончания работы двигателя.
        /// </summary>
        /// <exception cref="RobotHardwareException">
        /// Произошла ошибка с оборудованием или робот не ответил вовремя.
        /// </exception>
        /// <remarks>
        /// <para>Метод вызывается всегда после того, как соединение с роботом
        /// было установлено методом <c>IRobotHardware.Connect()</c>.
        /// Однако метод не вызывается в синхронизованном контексте,
        /// поэтому не должен полагаться на неизменность состояния,
        /// сохраняемого в данном объекте <see cref="IRobotEngine"/>.</para>
        /// <para>В случае невозможности успешного выполнения задачи
        /// (например из-за ошибки с оборудованием робота)
        /// метод должен выбрасывать исключение <c>RobotHardwareException</c>.
        /// Другие типы исключений недопустимы.</para>
        /// </remarks>
        /// <seealso cref="IRobotEngine"/>
        /// <seealso cref="IRobotHardware"/>
        /// <seealso cref="RobotHardwareException"/>
        void Stop();
    }
}
